home *** CD-ROM | disk | FTP | other *** search
/ Games of Daze / Infomagic - Games of Daze (Summer 1995) (Disc 1 of 2).iso / x2ftp / msdos / libs / stk110 / spred.doc < prev    next >
Text File  |  1991-02-25  |  6KB  |  163 lines
  1. **********************************************************************
  2.                     This file is part of
  3.  
  4.          STK -- The sprite toolkit -- version 1.1
  5.  
  6.               Copyright (C) Jari Karjala 1991
  7.  
  8. The sprite toolkit (STK) is a FreeWare toolkit for creating high
  9. resolution sprite graphics with PCompatible hardware. This toolkit 
  10. is provided as is without any warranty or such thing. See the file
  11. COPYING for further information.
  12.  
  13. **********************************************************************
  14.  
  15.  
  16.  
  17. SPRED -- Sprite editor for the sprite toolkit -- version 1.1, Jan 14, 1991 
  18.  
  19.  
  20.  
  21. Intro
  22. -----
  23.  
  24. The sprite shape and mask bitmaps can be designed very easily
  25. with the SPRED program. This program allows you to draw the
  26. bitmaps of a sprite on screen by using a mouse, and manipulate
  27. the bitmaps in various ways, for example invert, flip and
  28. rotate. It is also possible to generate automatically the
  29. mask bitmap from the shape bitmap.
  30.  
  31.  
  32.  
  33. Requirements & Starting SPRED
  34. -----------------------------
  35.  
  36. The SPRED needs about 120 kBytes memory, a EGA/VGA/Hercules
  37. graphics adapter, and a mouse with a Microsoft compatible mouse
  38. driver.
  39.  
  40. The SPRED has the following commandline usage:
  41.  
  42. SPRED [-WxH] file[.ext] [...]
  43.  
  44. The file is the name(s) of the sprite map(s) file to edit,
  45. default extension is SMP. If you have a file without any
  46. extension, use a dot in the end of the name, eg foo. , to
  47. prevent SPRED from inserting the SMP extension.
  48.  
  49. The optional parameter WxH defines the Width and the Height of
  50. the sprite in pixels. If no WxH parameter were given, the size
  51. of the sprite in the given file is used. The largest size
  52. allowed is 120x80. In practice, anything larger than 80x64 is
  53. too hard to draw with the SPRED. Fortunately, SPRED can read X
  54. bitmaps and it is not hard to write converters for other bitmap
  55. formats, either (see the file format description below).
  56.  
  57. The SPRED will now load the file (if it exists) and then draw
  58. the main display. 
  59.  
  60.  
  61.  
  62. How to use SPRED
  63. ----------------
  64.  
  65. The main display contains the shape and mask bitmaps of the
  66. sprite in normal size, and the bitmap which you are editing (the
  67. shape bitmap by default) is shown in fatbits mode.  At the
  68. bottom of the screen there are command buttons.  Most commands
  69. affect only to the bitmap shown in the fatbits display (the
  70. active bitmap).
  71.  
  72. You can edit the bitmap in the fatbits display by the mouse. The
  73. left button sets bit on, the right button sets it off, and the
  74. middle button (or both buttons in two-button mouse) toggles the
  75. state of the bit. If you click the normal size shape or mask
  76. bitmap, the fatbits display will change to that bitmap.
  77.  
  78. The command buttons have the following functions (shortcut key
  79. is given in brackets):
  80.  
  81.  
  82. Clear           Clear the active bitmap. [Alt-C]
  83. Load            Load the sprite maps from a file (merge it into
  84.                 current map). Note, that the bitmap size cannot be
  85.                 changed. [Alt-L]
  86. Save            Save the sprite maps into a file. [Alt-S]
  87. Next Sprite     Load the next sprite given in the commandline. [Alt-N]
  88. Prev Sprite     Load the previous sprite given in the commandline. [Alt-P]
  89. Save & Exit     Save the sprite maps and exit SPRED. [Alt-X]
  90. Quit            Quit with no questions asked. [Alt-Q]
  91.  
  92. Invert          Invert the active map. [i]
  93. Make fatter     Change the background bits which have a
  94.                 neighbour bit in foreground color into
  95.                 foreground color. Try it, it is harder to
  96.                 explain than use! [f]
  97. Make thinner    The above idea reversed. (Especially useful when
  98.                 creating masks.) [t]
  99. Overlay         Overlay the inactive bitmap over the active map
  100.                 in the fatbits display. Choose the shape or mask
  101.                 bitmap to overwrite the overlay. [o]
  102. Shape->Mask     Copy shape bitmap to mask bitmap, invert it and
  103.                 set the mask bitmap as active bitmap. [none]
  104. Mask->Shape     Copy mask bitmap to shape bitmap, invert it and
  105.                 set the shape bitmap as active bitmap. [none]
  106.  
  107. Horiz Flip      Flip the active bitmap horizontally. [h]
  108. Vert Flip       Flip the active bitmap vertically. [v]
  109. Horiz Mirror    Flip the active bitmap horizontally, OR over old image. [none]
  110. Vert Mirror     Flip the active bitmap vertically, OR over old image. [none]
  111. Rotate          Rotate the active bitmap given angle (in
  112.                 degrees) anticlockwise. The rotation is not very
  113.                 accurate, so you should not use incremental
  114.                 rotations, that is to get 60 degrees, do not
  115.                 rotate 30 degrees twice. [r] 
  116. Rotate 90deg    Rotate the active bitmap 90 degrees
  117.                 anticlockwise. [none]
  118.  
  119. (The empty buttons are reserved for future expansion...)
  120.  
  121.  
  122.  
  123. The SPRED file format
  124. ---------------------
  125.  
  126. The sprite bitmap files are in C source code format, which are
  127. ready to be #included into your programs. It is easy to write a
  128. program to convert these into binary files which can be read at
  129. runtime, if you do not want to include them into your executable
  130. code or distribute the sprite maps in ASCII format. 
  131.  
  132. First there is a comment line starting with string "/* SMP".
  133. Then follows two lines in format #define XXXXX_YY NN, where
  134. XXXXX is the name of the sprite map (and filename), YY is string
  135. "width" or "height" and NN is the value in pixels. After defines
  136. there are two byte arrays for the shape and mask bitmaps of the
  137. sprite. The leftmost bit of the image is the most significant
  138. bit of the byte.
  139.  
  140. The fileformat is quite similar to the X Window System
  141. bitmap-file format, and the SPRED can read X bitmaps. The X
  142. bitmaps, however, have a reversed bit order within bytes and
  143. they do not have mask bitmaps. If you load an X bitmap and then
  144. save it, the SPRED will convert the file into SMP format.  The
  145. SMP files have a string "/* SMP" in the beginning of the first
  146. line. If this string is not found the file is assumed to be an X
  147. bitmap.
  148.  
  149.  
  150. **********************************************************************
  151.  
  152. If you have any comments, suggestions, bug reports (and fixes
  153. since I gave you the source!), let me know. I would also like to
  154. hear about the programs you create with the aid of the Sprite
  155. Toolkit. 
  156.  
  157. Jari Karjala
  158. Veropellontie 11
  159. 00780 Helsinki
  160. Finland
  161.  
  162. FUNET: jka@niksula.hut.fi
  163.